﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System.Collections.Generic;

#endregion

namespace ScrumTable.DL.Data.Common.Config.Schema
{
    /// <summary>
    /// Represents a container for Schema source instances. You should use
    /// and set the Selected instance in before creating the data driver.
    /// </summary>
    public interface IDataSchemaSelector : IEnumerable<IDataSchemaSource>
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        /// <summary>
        /// Gets/sets the selected schema source instance. This instance will
        /// be passed to the underlying data driver in order to create the
        /// data layer context.
        /// </summary>
        IDataSchemaSource Selected { get; set; }

        /// <summary>
        /// Gets/sets the default schema configuration instance. This corresponds
        /// to the internal configuration instance which cannot be modified.
        /// </summary>
        IDataSchemaSource Default { get; }

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        /// <summary>
        /// Creates a new data schema source and returns the created instance.
        /// The new source will contain the default configuration data provided
        /// by the underlying data assembly driver.
        /// </summary>
        IDataSchemaSource Create();

        #endregion

        #region Events

        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}